Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

refactor: Move sdk.Dec to math package #12634

Merged
merged 10 commits into from
Jul 20, 2022
Merged

refactor: Move sdk.Dec to math package #12634

merged 10 commits into from
Jul 20, 2022

Conversation

amaury1093
Copy link
Contributor

Description

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@amaury1093 amaury1093 marked this pull request as ready for review July 19, 2022 19:07
@amaury1093 amaury1093 requested a review from a team as a code owner July 19, 2022 19:07
julienrbrt
julienrbrt reviewed Jul 19, 2022
View reviewed changes
math/CHANGELOG.md Outdated
@@ -30,3 +30,5 @@ Ref: https://keepachangelog.com/en/1.0.0/
# Changelog

## [Unreleased]

* [#12634](https://github.com/cosmos/cosmos-sdk/pull/12634) Move `sdk.Dec` to math package.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add this same entry in the root changelog as well?

@faddat
Copy link
Contributor

faddat commented Jul 20, 2022

massively appreciated change.

Thanks @AmauryM !

aaronc
aaronc requested changes Jul 20, 2022
View reviewed changes
Copy link
Member

@aaronc aaronc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we call this math.LegacyDec please? (Keeping aliases as sdk.Dec is still fine). And also start merging the GDA/apd code so we get that done for once and for all (ref #11783)?

The code I'm referring to is this code: https://github.com/regen-network/regen-ledger/blob/master/types/math/dec.go. We've had it tested and in use for a while - the main difference is this Dec returns errors rather than panicking which I think is good.

@amaury1093
Copy link
Contributor Author

I did this in 7304e08. TBH I'm not convinced. The API looks ugly with Legacy in front of all the names.

One advantage of having versioned go modules is that we could stop calling stuff legacy, right? I'm more in favor or keeping it in v1. sdk.Dec, even though it has bugs, has been used long enough in production chains to be deemed as v1.

@amaury1093 amaury1093 added the A:automerge Automatically merge PR once all prerequisites pass. label Jul 20, 2022
@mergify mergify bot merged commit eee23d9 into main Jul 20, 2022
@mergify mergify bot deleted the am/sdk-dec branch July 20, 2022 15:13
@yihuang yihuang mentioned this pull request Aug 31, 2022
Merged
@amaury1093 amaury1093 mentioned this pull request Sep 5, 2022
Closed
1 task
@p0mvn p0mvn mentioned this pull request Aug 17, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@julienrbrt julienrbrt julienrbrt approved these changes

@tac0turtle tac0turtle tac0turtle approved these changes

@alexanderbez alexanderbez alexanderbez approved these changes

@aaronc aaronc aaronc approved these changes

Assignees
No one assigned
Labels
A:automerge Automatically merge PR once all prerequisites pass.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@amaury1093 @faddat @aaronc @alexanderbez @tac0turtle @julienrbrt